home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / ho5m.zip / MNU.TXT < prev    next >
Text File  |  1995-02-02  |  19KB  |  515 lines
  1.  
  2.  
  3.                     MNU  Manual          Page 1
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                         _______
  10.                    ____|__     |               (R)
  11.                 --|       |    |-------------------
  12.                   |   ____|__  |  Association of
  13.                   |  |       |_|  Shareware
  14.                   |__|   o   |    Professionals
  15.                 -----|   |   |---------------------
  16.                      |___|___|    Member
  17.  
  18.  
  19.  
  20.                 Version 3.00           December, 1994
  21.  
  22.  
  23.           MNU, is a batch file enhancer, readme tool, and menu program.
  24.           Its included to help make the overall package easier to use
  25.           and to adapt to your needs, and to show you how you can use
  26.           the remote support/package package with your favourite menu
  27.           program.
  28.  
  29.  
  30.  
  31.  
  32.           MNU has 3 main modes:  ASK, MENU, and README
  33.  
  34.           Each of the modes can have behaviour changes depending on
  35.           various settings.  Much of the documentation suggests using
  36.           environmental variables, but you can use the MNU.INI file as
  37.           documented after the mode descriptions instead.
  38.  
  39.  
  40.           1) ASK MODE is a simple way of asking for user input within a
  41.           batch file.  It displays the "input string" at the current
  42.           screen position and waits for a one key response.  Only keys
  43.           in the "key list" are allowed:
  44.  
  45.           MNU ASK <input string>  - The string to display
  46.              <key list>      - Keys that are acceptable responses
  47.              [DEFAULT=c]     - The default key if enter is pressed
  48.              [TIMEOUT=n]     - The number of seconds to wait
  49.              [DEBUG]         - Causes the errorlevel to be displayed
  50.              [NOTIME]        - Time remaining won't be displayed.
  51.  
  52.           Upon exit it sets the DOS Errorlevel based on the order of key
  53.           pressed.
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                     MNU  Manual          Page 2
  61.  
  62.  
  63.  
  64.           Example:  MNU ASK "<O>ki, <L>aser, <E>pson (press O, L, or
  65.           E):  " OLE
  66.  
  67.           After displaying "<O>ki, <L>aser, <E>pson (press O, L, or E):
  68.           " it waits for a keypress.If it's in the group (OLEole) it
  69.           sets the DOS Errorlevel according to the order in the key list
  70.           and exits.  Esc exits with 0.  Other options can be placed
  71.           after the key list:
  72.  
  73.           DEFAULT - This is used to set a Default Key, to be used if
  74.           Enter is pressed or a TIMEOUT is reached.  If "default=a" is
  75.           used, then when the user presses Enter, it would be the same
  76.           as pressing "a".
  77.  
  78.           TIMEOUT - An example would be "timeout=30".  If no key is
  79.           pressed within 30 seconds the program will terminate.  If
  80.           there is a DEFAULT key set, it will act as if that key were
  81.           pressed.
  82.  
  83.           DEBUG - (or /debug) This shows the DOS Errorlevel upon exit.
  84.  
  85.           NOTIME - This prevents the time remaining from being displayed
  86.           when TIMEOUT is active.
  87.  
  88.           An example linked to TeleShare:
  89.  
  90.           echo off
  91.           REM This could be part of your autoexec.bat
  92.           REM Put the MNU line, DEFAULT=Y and TIMEOUT=10 on one line.
  93.           MNU ask "Load TeleShare? Y or N?" YN DEFAULT=Y TIMEOUT=10
  94.           REM
  95.           if errorlevel == 2 goto :bypass
  96.           if errorlevel == 1 goto :loadtele
  97.           goto :bypass
  98.           :loadtele
  99.           rem The TSH could be TSR on the 'local' machine
  100.           TSH
  101.           :bypass
  102.           rem continue autoexec.bat
  103.  
  104.           A similar batch file could load a portion of the Hands On
  105.           remote access package.
  106.  
  107.  
  108.           2) MENU MODE is used to paint a menu on screen and allow users
  109.           to select a choice by positioning a light bar, or letter, and
  110.           pressing enter.  Normally the menu is full screen but the NC
  111.           option reduces the menu to a minimum size.  This allows you to
  112.  
  113.  
  114.  
  115.  
  116.  
  117.                     MNU  Manual          Page 3
  118.  
  119.  
  120.  
  121.           stack successive menus, offset if you like, and to have the
  122.           menus pop up anywhere on the screen.  MENU MODE returns the
  123.           DOS errorlevel set to the sequence number of the item
  124.           selected.
  125.  
  126.  
  127.           MNU MENU <options list separated by commas or spaces>
  128.           [options]
  129.  
  130.           - MENU mode is used to pop up a list of menu choices.  When
  131.           the user selects one and presses "Enter", it sets the DOS
  132.           Errorlevel based on the order of the item chosen.
  133.  
  134.           Example:  MNU MENU "Oki Printer","Laser Printer","Epson
  135.           Printer"
  136.  
  137.           - A BOX will be displayed giving the options in a LIST.  The
  138.           user may choose an option using the up and down arrow keys and
  139.           then press enter.  It will set the DOS Errorlevel according to
  140.           the order of option chosen and then exit.
  141.  
  142.           - There is a DEBUG option.  If "debug" or "/debug" is placed
  143.           after the option list it will show the DOS Errorlevel upon
  144.           exit.
  145.  
  146.           - The LOCATION of the box can be controlled by setting an
  147.           environment variable.  Type the following at the command line
  148.           or in a batch file "set twp=1012".  This would set the upper
  149.           left corner of the box to row 10, column 12.  The coordinates
  150.           must contain 4 numbers.  For instance row 9, column 1 would be
  151.           "set twp=0901". Row 0, column 0 would be "set twp=0000".  If
  152.           you use the MNU.INI file to set TWP you lose the capability to
  153.           'stack' successive menus offset like cards unless you put
  154.           different MNU.INI files in different subdirectories.
  155.  
  156.           - A title will be placed at the top of the menu box, if the
  157.           parameters include "t:title".
  158.  
  159.           Example:  MNU MENU "t:Printer Menu" "Oki" "Laser" "Epson"
  160.  
  161.           - To create overlaid menus, use "NC" as a parameter.  The
  162.           screen won't be cleared before popping up the new menu.  You
  163.           can also use NC to make minimal sized menus.
  164.  
  165.           Example:  MNU MENU "NC" "t:Printer Menu" "Oki" "Laser" "Epson"
  166.  
  167.           - You can set an environment variable (TWH) to over-ride the
  168.           default header of "Menu Choices".  If you rename MNU to HOMNU
  169.  
  170.  
  171.  
  172.  
  173.  
  174.                     MNU  Manual          Page 4
  175.  
  176.  
  177.  
  178.           the header becomes 'Hands On Remote Access' without using
  179.           environment space.
  180.  
  181.           Example:  SET TWH=ACME COMPANY MENU
  182.  
  183.           - You can set an environment variable (TWSAV) to cause the
  184.           screen to be cleared and your message (up to 60 characters) to
  185.           be displayed.  If you run out of environment space the message
  186.           will be truncated.
  187.  
  188.           Example:  SET TWSAV=I'm at Lunch.  Return 1:30
  189.  
  190.           The screen saver activates when you tap F7, and the screen is
  191.           restored when you tap another key.  You can also use the
  192.           command line parameter or switch -NOBURN to have the screen
  193.           saver automatically start up when the menu starts.  It starts
  194.           up every time you restart the menu when used this way, so you
  195.           might consider a 'startup' menu that includes -noburn and a
  196.           'working' menu batch file setup for 'during the day' usage.
  197.  
  198.  
  199.           MNU menu "t:Main Menu" "WordPerfect" "Lotus" "Quit" -NOBURN
  200.           # a sample startup with the -NOBURN option
  201.  
  202.           Note that you can leave this screen saver running while the
  203.           remote access host is resident and waiting for a call, and it
  204.           will appear when the connection is completed.  This also
  205.           provides an initial menu of choices.
  206.  
  207.  
  208.           You can add command line password capability by adding -P for
  209.           password and either including a password in the batch file or
  210.           running the batch file with a command line password.  The
  211.           password capability is tied to the screen saver.  If you use
  212.           -P, but do not use -NOBURN the screen saver is activated as if
  213.           you used -NOBURN.
  214.  
  215.           # an example using password capability as a parameter
  216.           MNU menu "t:Main Menu" "WordPerfect" "Quattro" "Quit" -P%1
  217.           or MNU menu "t:Main Menu" "Qedit" "dBase" "Quit" %1
  218.  
  219.           # an example including the actual password (demoPASSWORD)
  220.           MNU menu "t:Main Menu" "WordPerfect" "Quit" -PdemoPASSWORD
  221.  
  222.           The passwords can be up to 20 characters long.  You will note
  223.           that passwords are normally hidden during entry.  However, if
  224.           you disable screen attributes with TSSETUP.EXE on the HOST end
  225.           the 'hiding' commands are disabled and the password will be
  226.  
  227.  
  228.  
  229.  
  230.  
  231.                     MNU  Manual          Page 5
  232.  
  233.  
  234.  
  235.           displayed to you while you enter it.  It continues to be
  236.           hidden on the host machine.
  237.  
  238.  
  239.           Here's an entire batch file using MNU MENU MODE:
  240.  
  241.           SAMPLE.BAT
  242.             @echo off
  243.             ** set twh=Acme Toys Inc.
  244.            :start
  245.            REM The %1 allows you to enter "SAMPLE -Ppassword"
  246.             MNU menu "t:Main Menu" "WordPerfect" "Games" "Quit" %1
  247.             if errorlevel == 4 goto :end
  248.             if errorlevel == 3 goto :games
  249.             if errorlevel == 2 goto :lotus
  250.             if errorlevel == 1 goto :wp
  251.             goto :end
  252.            :wp
  253.             cd \wp51
  254.             wp
  255.             goto :start
  256.            :lotus
  257.             cd \123r24
  258.             123
  259.             goto :start
  260.            :games
  261.             call gamemenu
  262.             goto :start
  263.            :end
  264.  
  265.           - USAGE TRACKING:  If an environment variable called TWDR is
  266.           set, MNU will record all user menu selections in a DBASE III
  267.           type data file called ACTIONS.DBF.  "TWDR" needs to be like
  268.           "C:", "D:", "F:" etc.  ACTIONS.DBF will be opened or created
  269.           in the root directory of the drive specified by "TWDR".  It
  270.           will also record the setting for the environment variables:
  271.           "LANUSER" and "TWID" (up to 10 characters each).
  272.  
  273.           Example:  SET TWDR=C:
  274.  
  275.           If you prefer, you may use "SET TWDR=C" without the ":" and
  276.           the ACTIONS.DBF will be created and maintained in the 'home
  277.           directory' where the MNU.EXE resides.
  278.  
  279.           You can use the F4 function key to look at and edit the
  280.           entries in the ACTIONS.DBF when the feature is active in MNU.
  281.  
  282.           We have found that the ACTIONS.DBF can be damaged leading to
  283.  
  284.  
  285.  
  286.  
  287.  
  288.                     MNU  Manual          Page 6
  289.  
  290.  
  291.  
  292.           MNU locking up when it tries to access ACTIONS.DBF.  If MNU
  293.           locks up on you, then first try erasing ACTIONS.DBF
  294.  
  295.           - MONO MONITOR MODE:  If you're running this on a mono or LCD
  296.           monitor you'll want to set an environment variable TWCLR for
  297.           black & white screens.
  298.  
  299.           Example:  SET TWCLR=MONO
  300.  
  301.  
  302.           3) README MODE is a command line text or ascii file browser.
  303.  
  304.           "Use `MNU -README' for a *.DOC list.  Then select from the
  305.           list.  `MNU -README \SOMEDIR\*.TXT' for .TXT files. ...
  306.  
  307.           The README mode has its own command-line usage, and is
  308.           normally run separately from the other two modes.  The initial
  309.           help provided when you just type in "MNU" or F1 help uses part
  310.           of the README browse engine.
  311.  
  312.  
  313.  
  314.           The documentation suggests various environment variables, all
  315.           starting with TW (Tom Woodgerd - the original author).  You
  316.           may use the environment for the purposes suggested here.
  317.           However, the environment is a limited resource and accidental
  318.           miss-use leads to various problems with all kinds of software,
  319.           so this version uses the MNU.INI file.  MNU looks for it in
  320.           the current directory and then the directory where the MNU.EXE
  321.           resides.  The MNU.INI file format is as follows:
  322.  
  323.           # setup information for mnu
  324.           TWP=1012
  325.           TWID=
  326.           TWDR=C
  327.           TWH=Hands On Remote Access
  328.           USER=
  329.           TWCLR=
  330.           SP=
  331.           TWSAV=  Shareware is simply another software distribution medium
  332.           # <- these allow following comments on the same line
  333.  
  334.           You can have alternate .INI files that are copied to MNU.INI
  335.           inside your batch file to change the pertinent settings in
  336.           successive MNU menus.
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.                     MNU  Manual          Page 7
  346.  
  347.  
  348.  
  349.           Support and Distribution:
  350.  
  351.           This product is partially Copyright (C) 1993-4 P. C. Softsmith
  352.           all rights reserved.  It is distributed with shareware and
  353.           should be distributed with this documentation.  It is normally
  354.           distributed with other P.C. Softsmith materials that further
  355.           explain the shareware process.  If you wish to distribute it
  356.           with your software or are unable to find the other
  357.           documentation that should accompany this file (such as the
  358.           SHR_WARE.DOC, FILE_ID.DIZ, and the VENDOR.DOC) please contact
  359.           whoever gave you the software or P.C. Softsmith.
  360.  
  361.  
  362.           For technical support, either call (604) 433-5189, or write to
  363.           Suite 606 - 6455 Willingdon Avenue, Burnaby, British Columbia,
  364.           Canada, V5H 4E4. You may also try leaving a Compuserve message
  365.           at 75020, 2664, or send email to
  366.  
  367.           INTERNET:vic_williams@mindlink.bc.ca
  368.  
  369.           You will likely be able to access us on the Vancouver FreeNet
  370.           in the near future.
  371.  
  372.           Portions (C) Copyright 1993-4 P. C. Softsmith all rights
  373.           reserved.
  374.  
  375.  
  376.           History:
  377.  
  378.           December 12, 1994 vw:  3.02 tidied the "None" readme option
  379.           November 24, 1994 vw:  3.01 added direct browse or readme if
  380.           only 1 file available.  November 20, 1994 vw:  Version 3.00
  381.           added command line README mode, with ties to the F1 help.
  382.           This was a separate browse or readme tool that has now been
  383.           merged with MNU.  November 17, 1994 vw:  Version 2.50 added
  384.           command line PASSWORD capability tied to -NOBURN November 1,
  385.           1994 vw:  Version 2.20 added command line -NOBURN.  September,
  386.           1994 vw:  Version 2.11 minor MNU.DOC changes.
  387.  
  388.           June, 1994 - vw:  Version 2.1 Added MNU.INI, some minor
  389.           internal changes and changed the screen saver.  Main title
  390.           changes if .exe name changed to HOMNU.EXE for use with Hands
  391.           On remote access.  This version automatically tries to display
  392.           an intelligent error message when something goes wrong.
  393.  
  394.           May, 1994 - vw:  more interactive screen saver and some minor
  395.           tinkering.  Added the F4 EDIT with ACTIONS.DBF optionally in
  396.           the home directory replacing TWSELECT.DBF in the root
  397.  
  398.  
  399.  
  400.  
  401.  
  402.                     MNU  Manual          Page 8
  403.  
  404.  
  405.  
  406.           directory.
  407.  
  408.           December, 1993 vw:  Version 2
  409.           This product has been reworked somewhat from the original
  410.           TWSELECT.
  411.  
  412.           The original version is distributed as TWSELECT, and you will
  413.           find various references to TWSELECT.  This version has been
  414.           renamed to avoid confusion because the two now have some
  415.           differences.  If your copy has some other name just mentally
  416.           substitute that name for 'MNU' and 'TWSELECT' as necessary.
  417.           The original source and .exe can likely still be found in the
  418.           Force area (GO FORCE) on Compuserve.
  419.  
  420.           This version has full ASP member support, and may still be
  421.           distributed freely.
  422.  
  423.           -This version has full ASP support, and may still be distributed
  424.           freely.  You can use us for free support.
  425.           -Added self detection of monochrome monitors.
  426.           -Moved help to separate .DOC file, for a smaller .exe and easier
  427.           maintenance.
  428.  
  429.  
  430.  
  431.           TWSELECT was written by Tom J. Woodgerd, using the FORCE
  432.           compiler.  It has been released into the public domain, to be
  433.           used freely.  The author provides no warranty or support, but
  434.           your comments and suggestions are welcome.
  435.  
  436.           Sept 11, 1992 - Tom J. Woodgerd, 1018 State St., Helena MT
  437.           59601.  You can leave messages on Worthy Computer BBS, (406)
  438.           443-7508.
  439.  
  440.           Sept 11, 1992 - TJW: Version 1.12
  441.           - Cleaned up the HELP screens and uploaded to several BBS's.
  442.           Worthy Computer, HUGE, FORCE BBS.
  443.           - Changed environment variable WPUSER to TWID.
  444.  
  445.           July 27, 1992 - TJW: Version 1.12
  446.           - Added mono capabitity.  Just "set twclr=mono".
  447.  
  448.           July 05, 1992 - TJW: Version 1.11
  449.           - Fixed bug in ASK.
  450.           - Changed USERNAME to LANUSER.
  451.           - Changed to not save history if errorlevel = 0.
  452.           - Added extra info to info screen (F1).
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                     MNU  Manual          Page 9
  460.  
  461.  
  462.  
  463.           June 29, 1992 - TJW: Version 1.10
  464.           - Changed to save all user selections to <twdr>\TWSELECT.DBF if
  465.           the environment variable "TWDR" is set to C: etc.
  466.  
  467.           June 26, 1992 - TJW: Version 1.09
  468.           - Changed to show time as hh:mm:ss.
  469.  
  470.           June 17, 1992 - TJW: Version 1.08
  471.           - Added Help Screen.  Added ability to display the TWSAV
  472.           message when in screen saver mode.
  473.  
  474.           June 15, 1992 - TJW: Version 1.07
  475.           - Unable to fix "timer_entry()" to not conflict with EXTRA!
  476.           and other tsrs.  The clock display and the screen saver now
  477.           only work if the environment variable "TWSAV" is set to "Y".
  478.  
  479.           June 13, 1992 - TJW: Version 1.06
  480.           - Fixed bug in "civilian" time display.
  481.  
  482.           June 10, 1992 - TJW: Version 1.05
  483.           - Added option to put the header in environment variable called TWP.
  484.           - Changed timeout to 10 minutes.
  485.  
  486.           May 26, 1992 - TJW: Version 1.04
  487.           - Changed lead in on menu items to "A. ", "B. ", etc.
  488.           - Changed menu header to use a box.
  489.  
  490.           May 13, 1992 - TJW: Version 1.03
  491.           - Added ability to jump to menu option when the first character
  492.           of the option is pressed.  Also got rid of automatic upper
  493.           casing on menu items.
  494.  
  495.  
  496.           P. C. Softsmith warranty information:
  497.  
  498.           THE DOCUMENTATION AND ASSOCIATED SOFTWARE ARE DISTRIBUTED AND
  499.           SOLD WITH NO WARRANTIES, EITHER EXPRESS OR IMPLIED, REGARDING
  500.           ITS MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE.
  501.           THE INFORMATION IN THIS DOCUMENTATION IS SUBJECT TO CHANGE
  502.           WITHOUT NOTICE AND DOES NOT REPRESENT A COMMITTMENT ON THE
  503.           PART OF THE VENDOR.
  504.  
  505.           OTHER PRODUCT AND BRAND NAMES MENTIONED ARE TRADEMARKS OR
  506.           REGISTERED TRADEMARKS OF THEIR RESPECTIVE HOLDERS.
  507.           SPECIFICALLY XBASE IS THE GENERIC DATABASE INDUSTRY
  508.           REPLACEMENT FOR THE REGISTERED TERM DBASE OWNED BY BORLAND
  509.           INTERNATIONAL.
  510.  
  511.  
  512.  
  513.  
  514.  
  515.